跳到主要内容

创建即时支付动态 PIX QR 码

即时支付动态 QR 码适用于支付期限较短（通常以秒计）的场景，用于日常即时收款操作。

请求​

请求体：即时支付动态 QR 码
{
  "request_control_key": "8a923886-afce-4116-ac1f-69bdffcf8da9",
  "qr_code_type": "dynamic_instant",
  "amount": 22.34,
  "receiver_conciliation_id": "01GVGV9NXBCY287Z6CJ4S0ENW9",
  "payer_document_number": "00000000000000",
  "payer_name": "Random",
  "payer_request": "Payment for order XXXXXXXXXX",
  "pix_key": "3d7d6a2b-f72f-44z7-bb20-79a94dff5645",
  "expiration_seconds": 864000,
  "additional_data": [
    {
      "key_name": "identificacao_venda",
      "value": "Venda número 123 na plataforma"
    }
  ],
}

请求体参数​

字段类型描述字符数
request_control_key *string请求的唯一 UUID4 标识符。-
qr_code_type *string动态 QR 码类型。"dynamic_term" 或 "dynamic_instant"
amount *floatQR 码在计算折扣或利息罚款前的金额。-
receiver_conciliation_id *string支付后用于对账的 QR 码标识符。-
payer_document_number *string付款方 CPF/CNPJ。-
payer_name *string付款方姓名。-
payer_request *string给付款方的消息。-
pix_key *string代表交易目标账户的 PIX 密钥。-
expiration_secondsstringQR 码的有效时间（秒），默认 1 天。-
additional_dataarray of objects将展示给付款方的信息。-

additional_data 对象​

字段类型描述字符数
key_name *string字段名称。-
valuestring字段值。-

响应​

STATUS
201 Created
响应体：创建即时支付动态 QR 码
{
  "request_control_key": "037b46b1-0c67-4c0d-aac3-1e395dfdcb10",
  "qr_code_key": "d74bf12a-9243-4bfa-9b00-6b63755b6555",
  "qr_code_status": "active",
  "base_64_payload": "<BASE64 DA URI DO PIX COPIA E COLA>",
  "created_at": "2023-03-03T12:04:06.179Z",
}
字段类型描述字符数
request_control_key *string请求的唯一 UUID4 标识符。-
qr_code_key *string用于后续请求的 QR 码标识符。-
qr_code_status *string系统中的 QR 码状态。"active"：创建时的默认值。
base_64_payload *stringBase64 格式的 QR 码支付 URL。-
created_at *datetimeQR 码在系统中的创建日期和时间。-

qr_code_status 对象​

字段类型描述字符数
activestringQR 码处于活跃状态，可用于支付。-
finishedstringQR 码已支付。-
written_offstringQR 码已被客户撤销。-
bank_written_offstringQR 码因期限过期被自动撤销。-
STATUS
400
响应体
{
    "title": "Bad Request",
    "description": "Invalid payload for QR Code creation.",
    "translation": "Payload inválido para a criação de QR Code.",
    "code": "QRI000003"
}